Skip to main content
Version: 3.7

Home

The Home page showcases published API Packs for consumption. You can easily browse and select packs using the Category menu and sorting options. Choose a category from the sidebar to filter packs and adjust the display order as needed. The search feature allows you to find specific APIs by entering keywords, which matches pack names or descriptions closely.

home

Filter the API Pack by category selection​

  1. Click on the appropriate category to view the API Packs in that category.

Select Category to browse

The API Packs in that category are displayed with a success message, as shown below.

Category sidebar

  1. Click the Close icon to clear the filter.

Search by keyword(s)​

The Search functionality searches for keyword matches in API Pack names, API Plans and short and detailed descriptions to display results. It provides quick search results and word suggestions. Search results are ordered based on exact matches and closely related results.

info

You can search for a certain term or keyword(s).

  1. Enter keywords in the search box located at the top right corner.

search

  1. Click the keyboard's Enter button.

The search result that matches the keyword is displayed as shown below.

search1

  1. Click the Close icon to close the clear the search results.

Subscribe to a Plan​

You can subscribe to Plans under a Pack that contains the set of operations you wish to use in your application. As an API subscriber, you may also select from several plans created by the Publisher user for the Pack based on their Throttling and Rate Limiting policies.

  1. Click on the API Pack to which you wish to subscribe.

subscribeplan

The Plan page appears as shown below.

subscribeplan1

  1. Click Subscribe.
info

The screen below will vary depending on the Authentication Type selected at the Plan level (Subscription key, IP Whitelisting, Header Key, Query Parameter).

If Subscription key is selected as the Authentication Type.​

The pop-up appears as shown below.

subscribeplan2

  1. Click Ok.
info

Click the Cancel button to terminate the subscription process.

Upon subscribing, the respective plan is updated as shown below.

If IP Whitelisting is selected as the Authentication Type.​

The pop-up appears as shown below.

subscribeplan4

  1. Enter IP value.

  2. Click Add.

  3. Enter CIDR value.

  4. Click Add.

  5. Click Ok.

Upon subscribing, the respective plan is updated as shown below.

If Header Key is selected as the Authentication Type.​

The pop-up appears as shown below.

subscribeplan5

  1. Enter Header Value.

  2. Click Ok.

Upon subscribing, the respective plan is updated as shown below.

If Query Parameter is selected as the Authentication Type.​

The pop-up appears as shown below.

subscribeplan6

  1. Enter Query Parameter Value.

  2. Click Ok.

Upon subscribing, the respective plan is updated as shown below.

View API Pack Documentation​

The documentation for an API Pack guides you through several critical activities that will help you get started with the Pack. It offers thorough instructions for making API requests through your applications.

  1. Click on the API Pack.

subscribeplan

The API Pack detail page appears as shown below.

viewdocument

info

If the user opens the pack, the Plans page appears by default.

  1. Click Documentation tab.

The Documentation page appears as shown below.

viewdocument1

info

The documentation is displayed only if the publisher user includes it while creating the API pack.

View Sample Data​

The Sample Data tab provides code examples that can be used to create a sample API request. It also shows you the sample response you might expect when you submit the sample request.

  1. Click on the API Pack.

subscribeplan

The API Pack detail page appears as shown below.

viewsampledata

info

If the user opens the pack, the Plans page appears by default.

  1. Click Sample Data tab.

The Sample Data page appears as shown below.

viewsampledata1

info

The Sample Data is displayed only if the publisher user includes it while creating the API pack.

Use the Discussion Forum​

The API Pack Details page on the Developer portal includes built-in discussion forum support. An API Pack-specific discussion forum facilitates collaboration and community support for each API Pack. Both new and existing customers can benefit from communicating with other developers who share their interests.

caution

This is a common conversation forum. Please do not disclose any sensitive information.

Add New Discussion​

  1. Click on the API Pack.

subscribeplan

The API Pack detail page appears as shown below.

discussion

info

If the user opens the pack, the Plans page appears by default.

  1. Click Discussion tab.

The Discussion page appears as shown below.

discussion1

  1. Click Add Topic.

Add Topic dialog box appears as shown below.

  1. Enter the Topic and Description.

  2. Select the Category from the drop down.

  3. Click Add.

On adding a topic, the confirmation message appears as shown below.

discussion2

Manage Bookmark​

The Developer portal allows you to create new bookmarks and delete them from the home page.

Create a bookmark​

  1. Click the Bookmark icon located in the lower right corner of the API Pack.

bookmark

The respective API pack is added to bookmark.

The Bookmark icon is updated and The confirmation message appears as shown below.

bookmark1

Remove a bookmark​

  1. Click the Bookmark icon in the lower right corner of the API Pack that has been bookmarked.

removebookmark

The respective API pack is removed from bookmark.

The Bookmark icon is updated and The confirmation message appears as shown below.

removebookmark1